docs: public-launch documentation pass#6
Merged
Merged
Conversation
- README: badges (CI/pkg.go.dev/Go Report Card/license/version), 'Why Forge' positioning section (when to use / when not to), verified-compiling Quick Start, accurate feature/bundle tables, fixed links - CONTRIBUTING.md: dev setup, task commands, change checklist, bundle-authoring guide, commit/PR conventions - CHANGELOG: Unreleased section documenting the breaking renames + security fixes with a migration guide - docs/: lean on pkg.go.dev — api-reference now orients + links to godoc instead of hand-maintained drift; getting-started corrected (gRPC is registrar-gated, Bundle interface includes Stop, JWT shows stream interceptor); index Grafana claim corrected - godoc: enriched framework observability/logging/http doc comments; documented health NoopLogger methods All doc code samples compiled against the real API. Full suite green, lint 0. Co-Authored-By: Claude Fable 5 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation pass for public release, against the now-frozen API (post rename/security/metrics work).
README
CONTRIBUTING.md (new)
Dev setup, task/go commands, the change checklist (build/test/fmt/lint/coverage), a bundle-authoring guide, and commit/PR conventions.
CHANGELOG
An Unreleased section documenting the breaking renames (Get*→de-prefixed, HealthStatus→Report, errors→forgeerrors), the pgx swap, and the security fixes — with a migration guide from 0.1.0.
docs/ — lean on pkg.go.dev
api-reference.mdnow orients readers and links to godoc per package instead of duplicating a 433-line hand-maintained reference that drifts.getting-started.mdcorrected: gRPC server is registrar-gated (not unconditional), theBundleinterface includesStop, and the JWT example registers both unary and stream interceptors.index.md: 'pre-built Grafana dashboards' → 'a starter Grafana dashboard' (there's one).godoc
Enriched doc comments on the framework observability/logging/http types (rendered on pkg.go.dev, now the primary API reference) and documented the remaining undocumented exported methods.
Every Go code sample in the README and getting-started was extracted and compiled against the module. Full
-racesuite green, lint 0 issues.🤖 Generated with Claude Code